﻿/****************************************************************************************************
	Copyright (C) 2010 RapidWebDev Organization (http://rapidwebdev.org)
	Author: Eunge, Legal Name: Jian Liu, Email: eunge.liu@RapidWebDev.org

	This program is free software: you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation, either version 2 of the License, or
	(at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with this program.  If not, see <http://www.gnu.org/licenses/>.
 ****************************************************************************************************/

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace RapidWebDev.SearchIndex.Contract
{
	/// <summary>
	/// The interface to create searching highlight fragment.
	/// </summary>
	public interface ISearchHighlighter
	{
		/// <summary>
		/// Resolve highlight fragment for UI rendering.
		/// </summary>
		/// <param name="s"></param>
		/// <returns></returns>
		string ResolveHighlightFragment(string s);

		/// <summary>
		/// Does any string in the parameter contain highlight fragment.
		/// </summary>
		/// <param name="sArray"></param>
		/// <returns></returns>
		bool ContainsHighlightFragment(params string[] sArray);
	}
}
